home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / plug-ins / common / screenshot.c < prev    next >
Encoding:
C/C++ Source or Header  |  2003-05-16  |  13.4 KB  |  507 lines
  1. /*  
  2.  *  ScreenShot plug-in
  3.  *  Copyright 1998-2000 Sven Neumann <sven@gimp.org>
  4.  *
  5.  *  Any suggestions, bug-reports or patches are very welcome.
  6.  * 
  7.  *  This plug-in uses the X-utility xwd to grab an image from the screen
  8.  *  and the xwd-plug-in created by Peter Kirchgessner (pkirchg@aol.com)
  9.  *  to load this image into the gimp.
  10.  *  Hence its nothing but a simple frontend to those utilities.
  11.  */
  12.  
  13. /* The GIMP -- an image manipulation program
  14.  * Copyright (C) 1995 Spencer Kimball and Peter Mattis
  15.  *
  16.  * This program is free software; you can redistribute it and/or modify
  17.  * it under the terms of the GNU General Public License as published by
  18.  * the Free Software Foundation; either version 2 of the License, or
  19.  * (at your option) any later version.
  20.  *
  21.  * This program is distributed in the hope that it will be useful,
  22.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24.  * GNU General Public License for more details.
  25.  *
  26.  * You should have received a copy of the GNU General Public License
  27.  * along with this program; if not, write to the Free Software
  28.  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  29.  */
  30.  
  31. #include "config.h"
  32.  
  33. #include <stdio.h>
  34. #include <errno.h>
  35. #include <sys/wait.h>
  36. #include <unistd.h>
  37. #ifdef __EMX__
  38. #include <process.h>
  39. #endif
  40.  
  41. #include <gtk/gtk.h>
  42.  
  43. #include <libgimp/gimp.h>
  44. #include <libgimp/gimpui.h>
  45.  
  46. #include "libgimp/stdplugins-intl.h"
  47.  
  48.  
  49. /* Defines */
  50. #define PLUG_IN_NAME        "extension_screenshot"
  51.  
  52. #ifndef XWD
  53. #define XWD "xwd"
  54. #endif
  55.  
  56. typedef struct
  57. {
  58.   gboolean   root;
  59.   gchar     *window_id;
  60.   guint      delay;
  61.   gboolean   decor;
  62. } ScreenShotValues;
  63.  
  64. static ScreenShotValues shootvals = 
  65. { 
  66.   FALSE,     /* root window */
  67.   NULL,      /* window ID */
  68.   0,         /* delay */
  69.   TRUE,      /* decorations */
  70. };
  71.  
  72.  
  73. static void      query (void);
  74. static void      run   (gchar      *name,
  75.             gint        nparams,
  76.             GimpParam  *param, 
  77.             gint       *nreturn_vals,
  78.             GimpParam **return_vals);
  79.  
  80. static void      shoot                (void);
  81. static gboolean  shoot_dialog         (void);
  82. static void      shoot_ok_callback    (GtkWidget *widget, 
  83.                        gpointer   data);
  84. static void      shoot_delay          (gint32     delay);
  85. static gint      shoot_delay_callback (gpointer   data);
  86.  
  87.  
  88. /* Global Variables */
  89. GimpPlugInInfo PLUG_IN_INFO =
  90. {
  91.   NULL,  /* init_proc  */
  92.   NULL,     /* quit_proc  */
  93.   query, /* query_proc */
  94.   run    /* run_proc   */
  95. };
  96.  
  97. /* the image that will be returned */
  98. gint32    image_ID = -1;
  99.  
  100. gboolean  run_flag = FALSE;
  101.  
  102.  
  103. /* Functions */
  104.  
  105. MAIN ()
  106.  
  107. static void
  108. query (void)
  109. {
  110.   static GimpParamDef args[] =
  111.   {
  112.     { GIMP_PDB_INT32,  "run_mode",  "Interactive, non-interactive" },
  113.     { GIMP_PDB_INT32,  "root",      "Root window { TRUE, FALSE }" },
  114.     { GIMP_PDB_STRING, "window_id", "Window id" }
  115.   };
  116.   static gint nargs = sizeof (args) / sizeof (args[0]);
  117.  
  118.   static GimpParamDef return_vals[] =
  119.   {
  120.     { GIMP_PDB_IMAGE, "image", "Output image" }
  121.   };
  122.   static gint nreturn_vals = sizeof (return_vals) / sizeof (return_vals[0]);
  123.  
  124.   gimp_install_procedure (PLUG_IN_NAME,
  125.               "Creates a screenshot of a single window or the whole screen",
  126.               "This extension serves as a simple frontend to the "
  127.               "X-window utility xwd and the xwd-file-plug-in. "
  128.               "After specifying some options, xwd is called, the "
  129.               "user selects a window, and the resulting image is "
  130.               "loaded into the gimp. Alternatively the whole "
  131.               "screen can be grabbed. When called non-interactively "
  132.               "it may grab the root window or use the window-id "
  133.               "passed as a parameter.",
  134.               "Sven Neumann <sven@gimp.org>",
  135.               "1998 - 2000",
  136.               "v0.9.5 (2000/10/29)",
  137.               N_("<Toolbox>/File/Acquire/Screen Shot..."),
  138.               NULL,
  139.               GIMP_EXTENSION,        
  140.               nargs, nreturn_vals,
  141.               args, return_vals);
  142. }
  143.  
  144. static void 
  145. run (gchar      *name,
  146.      gint        nparams,
  147.      GimpParam  *param,
  148.      gint       *nreturn_vals,
  149.      GimpParam **return_vals)
  150. {
  151.   /* Get the runmode from the in-parameters */
  152.   GimpRunModeType run_mode = param[0].data.d_int32;    
  153.  
  154.   /* status variable, use it to check for errors in invocation usualy only 
  155.    * during non-interactive calling
  156.    */
  157.   GimpPDBStatusType status = GIMP_PDB_SUCCESS;     
  158.  
  159.   /* always return at least the status to the caller. */
  160.   static GimpParam values[2];
  161.  
  162.   /* initialize the return of the status */     
  163.   values[0].type          = GIMP_PDB_STATUS;
  164.   values[0].data.d_status = status;
  165.   *nreturn_vals = 1;
  166.   *return_vals  = values;
  167.  
  168.   /* how are we running today? */
  169.   switch (run_mode)
  170.     {
  171.     case GIMP_RUN_INTERACTIVE:
  172.       /* Possibly retrieve data from a previous run */
  173.       gimp_get_data (PLUG_IN_NAME, &shootvals);
  174.       shootvals.window_id = NULL;
  175.  
  176.       INIT_I18N_UI ();
  177.  
  178.      /* Get information from the dialog */
  179.       if (!shoot_dialog ())
  180.     status = GIMP_PDB_EXECUTION_ERROR;
  181.       break;
  182.  
  183.     case GIMP_RUN_NONINTERACTIVE:
  184.       if (nparams == 3) 
  185.     {
  186.       shootvals.root      = param[1].data.d_int32;
  187.       shootvals.window_id = (gchar*) param[2].data.d_string;
  188.       shootvals.delay     = 0;
  189.       shootvals.decor     = FALSE;
  190.     }
  191.       else
  192.     status = GIMP_PDB_CALLING_ERROR;
  193.       break;
  194.  
  195.     case GIMP_RUN_WITH_LAST_VALS:
  196.       /* Possibly retrieve data from a previous run */
  197.       gimp_get_data (PLUG_IN_NAME, &shootvals);
  198.       break;
  199.  
  200.     default:
  201.       break;
  202.     }
  203.  
  204.   if (status == GIMP_PDB_SUCCESS)
  205.     {
  206.       if (shootvals.delay > 0)
  207.     shoot_delay (shootvals.delay);
  208.       /* Run the main function */
  209.       shoot ();
  210.  
  211.       status = (image_ID != -1) ? GIMP_PDB_SUCCESS : GIMP_PDB_EXECUTION_ERROR;
  212.     }
  213.  
  214.   if (status == GIMP_PDB_SUCCESS)
  215.     {
  216.       if (run_mode == GIMP_RUN_INTERACTIVE)
  217.     {
  218.       /* Store variable states for next run */
  219.       gimp_set_data (PLUG_IN_NAME, &shootvals, sizeof (ScreenShotValues));
  220.       /* display the image */
  221.       gimp_display_new (image_ID);
  222.     }
  223.       /* set return values */
  224.       *nreturn_vals = 2;
  225.       values[1].type = GIMP_PDB_IMAGE;
  226.       values[1].data.d_image = image_ID;
  227.     }
  228.  
  229.   values[0].data.d_status = status; 
  230. }
  231.  
  232.  
  233. /* The main ScreenShot function */
  234. static void 
  235. shoot (void)
  236. {
  237.   GimpParam *params;
  238.   gint       retvals;
  239.   gchar     *tmpname;
  240.   gchar     *xwdargv[7];    /*  need a maximum of 7 arguments to xwd  */
  241.   gdouble    xres, yres;
  242.   gint       pid;
  243.   gint       wpid;
  244.   gint       status;
  245.   gint       i = 0;
  246.  
  247.   /*  get a temp name with the right extension  */
  248.   tmpname = gimp_temp_name ("xwd");
  249.  
  250.   /*  construct the xwd arguments  */
  251.   xwdargv[i++] = XWD;
  252.   xwdargv[i++] = "-out";
  253.   xwdargv[i++] = tmpname;
  254.   if ( shootvals.root == TRUE )
  255.     xwdargv[i++] = "-root";
  256.   else 
  257.     {
  258.       if (shootvals.decor == TRUE )
  259.     xwdargv[i++] = "-frame";
  260.       if (shootvals.window_id != NULL)
  261.     {
  262.       xwdargv[i++] = "-id";
  263.       xwdargv[i++] = shootvals.window_id;
  264.     }
  265.     }
  266.   xwdargv[i] = NULL;
  267.   
  268. #ifndef __EMX__
  269.   /*  fork off a xwd process  */
  270.   if ((pid = fork ()) < 0)
  271.     {
  272.       g_message ("screenshot: fork failed: %s\n", g_strerror (errno));
  273.       return;
  274.     }
  275.   else if (pid == 0)
  276.     {
  277.       execvp (XWD, xwdargv);
  278.       /*  What are we doing here? exec must have failed  */
  279.       g_message ("screenshot: exec failed: xwd: %s\n", g_strerror (errno));
  280.       return;
  281.     }
  282.   else
  283. #else /* __EMX__ */
  284.   pid = spawnvp (P_NOWAIT, XWD, xwdargv);
  285.   if (pid == -1)
  286.     {
  287.       g_message ("screenshot: spawn failed: %s\n", g_strerror (errno));
  288.       return;
  289.     }
  290. #endif
  291.     {
  292.       status = -1;
  293.       wpid = waitpid (pid, &status, 0);
  294.  
  295.       if ((wpid < 0) || !WIFEXITED (status))
  296.     {
  297.       /*  the tmpfile may have been created even if xwd failed  */
  298.       unlink (tmpname);
  299.       g_free (tmpname);
  300.       g_message ("screenshot: xwd didn't work\n");
  301.       return;
  302.     }
  303.     }
  304.  
  305.   /*  now load the tmpfile using the xwd-plug-in  */
  306.   params = gimp_run_procedure ("file_xwd_load",
  307.                    &retvals,
  308.                    GIMP_PDB_INT32, 1,
  309.                    GIMP_PDB_STRING, tmpname,
  310.                    GIMP_PDB_STRING, tmpname,
  311.                    GIMP_PDB_END);
  312.   if (params[0].data.d_status == GIMP_PDB_SUCCESS)
  313.     {
  314.       image_ID = params[1].data.d_image;
  315.     }
  316.   gimp_destroy_params (params, retvals);
  317.  
  318.   /*  get rid of the tmpfile  */
  319.   unlink (tmpname);
  320.   g_free (tmpname);
  321.  
  322.   if (image_ID != -1)
  323.     {
  324.       GimpParasite *parasite;
  325.       gchar *comment;
  326.       
  327.       /*  figure out the monitor resolution and set the image to it  */
  328.       gimp_get_monitor_resolution (&xres, &yres);      
  329.       gimp_image_set_resolution (image_ID, xres, yres);
  330.  
  331.       /*  unset the image filename  */
  332.       gimp_image_set_filename (image_ID, "");
  333.  
  334.       
  335.       /* Set the default comment parasite */
  336.       comment = gimp_gimprc_query ("default-comment");
  337.       
  338.       if (comment != NULL)
  339.         {
  340.           parasite = gimp_parasite_new ("gimp-comment", 
  341.                                         GIMP_PARASITE_PERSISTENT,
  342.                                         strlen (comment) + 1,
  343.                                         comment);
  344.  
  345.           gimp_image_parasite_attach (image_ID, parasite);
  346.           gimp_parasite_free(parasite);
  347.         }
  348.     }
  349.  
  350.   return;
  351. }
  352.  
  353.  
  354. /*  ScreenShot dialog  */
  355.  
  356. static void
  357. shoot_ok_callback (GtkWidget *widget, 
  358.            gpointer   data)
  359. {
  360.   run_flag = TRUE;
  361.   gtk_widget_destroy (GTK_WIDGET (data));
  362. }
  363.  
  364. static gboolean
  365. shoot_dialog (void)
  366. {
  367.   GtkWidget *dialog;
  368.   GtkWidget *main_vbox;
  369.   GtkWidget *frame;
  370.   GtkWidget *vbox;
  371.   GtkWidget *hbox;
  372.   GtkWidget *label;
  373.   GtkWidget *button;
  374.   GtkWidget *decor_button;
  375.   GtkWidget *spinner;
  376.   GtkWidget *sep;
  377.   GSList    *radio_group = NULL;
  378.   GtkObject *adj;
  379.  
  380.  
  381.   gimp_ui_init ("screenshot", FALSE);
  382.  
  383.   /*  main dialog  */
  384.   dialog = gimp_dialog_new (_("Screen Shot"), "screenshot",
  385.                 gimp_standard_help_func, "filters/screenshot.html",
  386.                 GTK_WIN_POS_MOUSE,
  387.                 FALSE, TRUE, FALSE,
  388.  
  389.                 _("OK"), shoot_ok_callback,
  390.                 NULL, NULL, NULL, TRUE, FALSE,
  391.                 _("Cancel"), gtk_widget_destroy,
  392.                 NULL, 1, NULL, FALSE, TRUE,
  393.  
  394.                 NULL);
  395.  
  396.   gtk_signal_connect (GTK_OBJECT (dialog), "destroy",
  397.               GTK_SIGNAL_FUNC (gtk_main_quit),
  398.               NULL);
  399.  
  400.   main_vbox = gtk_vbox_new (FALSE, 4);
  401.   gtk_container_set_border_width (GTK_CONTAINER (main_vbox), 6);
  402.   gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox), main_vbox,
  403.               TRUE, TRUE, 0);
  404.   gtk_widget_show (main_vbox);
  405.  
  406.   /*  single window  */
  407.   frame = gtk_frame_new (_("Grab"));
  408.   gtk_frame_set_shadow_type (GTK_FRAME (frame), GTK_SHADOW_ETCHED_IN);
  409.   gtk_box_pack_start (GTK_BOX (main_vbox), frame, FALSE, FALSE, 0);
  410.  
  411.   vbox = gtk_vbox_new (FALSE, 2);
  412.   gtk_container_set_border_width (GTK_CONTAINER (vbox), 4);
  413.   gtk_container_add (GTK_CONTAINER (frame), vbox);
  414.  
  415.   button = gtk_radio_button_new_with_label (radio_group, _("Single Window"));
  416.   radio_group = gtk_radio_button_group (GTK_RADIO_BUTTON (button));  
  417.   gtk_box_pack_start (GTK_BOX (vbox), button, FALSE, FALSE, 0);
  418.   gtk_signal_connect (GTK_OBJECT (button), "toggled",
  419.               (GtkSignalFunc) gimp_radio_button_update,
  420.               &shootvals.root);
  421.   gtk_object_set_user_data (GTK_OBJECT (button), (gpointer) FALSE);
  422.   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button), ! shootvals.root);
  423.   gtk_widget_show (button);
  424.  
  425.   /*  with decorations  */
  426.   hbox = gtk_hbox_new (FALSE, 2);
  427.   gtk_box_pack_start (GTK_BOX (vbox), hbox, TRUE, TRUE, 0);
  428.   decor_button =
  429.     gtk_check_button_new_with_label (_("With Decorations"));
  430.   gtk_signal_connect (GTK_OBJECT (decor_button), "toggled",
  431.                       (GtkSignalFunc) gimp_toggle_button_update,
  432.                       &shootvals.decor);
  433.   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (decor_button), 
  434.                 shootvals.decor);
  435.   gtk_object_set_data (GTK_OBJECT (button), "set_sensitive", decor_button);
  436.   gtk_box_pack_end (GTK_BOX (hbox), decor_button, FALSE, FALSE, 0);
  437.   gtk_widget_show (decor_button);
  438.   gtk_widget_show (hbox);
  439.  
  440.   sep = gtk_hseparator_new ();
  441.   gtk_box_pack_start (GTK_BOX (vbox), sep, FALSE, FALSE, 0);
  442.   gtk_widget_show (sep);
  443.  
  444.   /*  root window  */
  445.   button = gtk_radio_button_new_with_label (radio_group, _("Whole Screen"));
  446.   radio_group = gtk_radio_button_group (GTK_RADIO_BUTTON (button));  
  447.   gtk_box_pack_start (GTK_BOX (vbox), button, FALSE, FALSE, 0);
  448.   gtk_signal_connect (GTK_OBJECT (button), "toggled",
  449.               (GtkSignalFunc) gimp_radio_button_update,
  450.               &shootvals.root);
  451.   gtk_object_set_user_data (GTK_OBJECT (button), (gpointer) TRUE);
  452.   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (button), shootvals.root);
  453.   gtk_widget_show (button);
  454.  
  455.   gtk_widget_show (vbox);
  456.   gtk_widget_show (frame);
  457.  
  458.   /*  with delay  */
  459.   hbox = gtk_hbox_new (FALSE, 4);
  460.   gtk_box_pack_start (GTK_BOX (main_vbox), hbox, FALSE, FALSE, 0);
  461.   label = gtk_label_new (_("after"));
  462.   gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
  463.   gtk_widget_show (label);
  464.  
  465.   adj = gtk_adjustment_new (shootvals.delay, 0.0, 100.0, 1.0, 5.0, 0.0);
  466.   gtk_signal_connect (GTK_OBJECT (adj), "value_changed",
  467.               gimp_int_adjustment_update, 
  468.               &shootvals.delay);
  469.   spinner = gtk_spin_button_new (GTK_ADJUSTMENT (adj), 0, 0);
  470.   gtk_box_pack_start (GTK_BOX (hbox), spinner, FALSE, FALSE, 0);
  471.   gtk_widget_show (spinner);
  472.  
  473.   label = gtk_label_new (_("Seconds Delay"));
  474.   gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
  475.   gtk_widget_show (label);
  476.  
  477.   gtk_widget_show (hbox);
  478.   gtk_widget_show (dialog);
  479.  
  480.   gtk_main ();
  481.  
  482.   return run_flag;
  483. }
  484.  
  485.  
  486. /*  delay functions  */
  487. void
  488. shoot_delay (gint delay)
  489. {
  490.   gint timeout;
  491.  
  492.   timeout = gtk_timeout_add (1000, shoot_delay_callback, &delay);  gtk_main ();
  493. }
  494.  
  495. gint 
  496. shoot_delay_callback (gpointer data)
  497. {
  498.   gint *seconds_left = (gint *)data;
  499.  
  500.   (*seconds_left)--;
  501.  
  502.   if (!*seconds_left) 
  503.     gtk_main_quit();
  504.  
  505.   return *seconds_left;
  506. }
  507.